// --------------------------------------------------------------------------------------------------------------------
// <copyright file="RGBCameraAgentMessage.cs" company="Microsoft Corporation">
// The MIT License (MIT)
// 
// Copyright (c) 2014, Microsoft Corporation
// 
// Permission is hereby granted, free of charge, to any person obtaining a copy
//  of this software and associated documentation files (the "Software"), to deal
//  in the Software without restriction, including without limitation the rights
//  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
//  copies of the Software, and to permit persons to whom the Software is
//  furnished to do so, subject to the following conditions:
// 
// The above copyright notice and this permission notice shall be included in
//  all copies or substantial portions of the Software.
// 
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
//  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
//  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
//  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
//  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
//  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
//  THE SOFTWARE.
// </copyright>
// --------------------------------------------------------------------------------------------------------------------
namespace Microsoft.Robotics.Vision.Runtime.Cameras
{
    using System;
    using System.Drawing;
    using System.Runtime.Serialization;

    using Microsoft.Robotics.Numerics;
    using Microsoft.Robotics.Runtime;
    using Microsoft.Robotics.Vision;

    /// <summary>
    /// The RGBCameraAgentMessage class represents RGB data from the webcam
    /// </summary>
    [DataContract]
    public class RGBCameraAgentMessage : AgentMessage
    {
        /// <summary>
        /// Initializes a new instance of the <see cref="RGBCameraAgentMessage" /> class
        /// </summary>
        /// <param name="originatingTime">The depth image creation time.</param>        
        /// <param name="rgbImage">The RGB image (formatted as Yuy2)</param>
        public RGBCameraAgentMessage(
            long originatingTime,
            ImageFrameYuy2 rgbImage)
            : base(originatingTime)
        {
            this.RGBImageFrame = rgbImage;
            this.CameraPose = new Pose();
            this.InterestPatch = new Rectangle();
            this.CameraId = null;
        }

        /// <summary>
        /// Initializes a new instance of the <see cref="RGBCameraAgentMessage" /> class
        /// </summary>
        /// <param name="originatingTime">The depth image creation time.</param>        
        /// <param name="rgbImage">The RGB image (formatted as Yuy2)</param>
        /// <param name="pose">Camera pose</param>
        /// <param name="patch">Patch of interest</param>
        /// <param name="cameraId">Camera identifier</param>
        public RGBCameraAgentMessage(
            long originatingTime,
            ImageFrameYuy2 rgbImage,
            Pose pose,
            Rectangle patch,
            string cameraId)
            : base(originatingTime)
        {
            this.RGBImageFrame = rgbImage;
            this.CameraPose = pose;
            this.InterestPatch = patch;
            this.CameraId = cameraId;
        }

        /// <summary>
        /// Gets the RGB image frame (formatted as Yuy2).
        /// </summary>
        [DataMember]
        public ImageFrameYuy2 RGBImageFrame { get; private set; }

        /// <summary>
        /// Gets pose of the camera (optional)
        /// </summary>
        [DataMember]
        public Pose CameraPose { get; private set; }

        /// <summary>
        /// Gets patch of interest (optional)
        /// </summary>
        [DataMember]
        public Rectangle InterestPatch { get; private set; }

        /// <summary>
        /// Gets the camera ID (optional)
        /// </summary>
        public string CameraId { get; private set; }
    }
}
